home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 May: Tool Chest / Developer CD Series Tool Chest (Apple Computer)(May 1999).iso / Tool Chest / Development Kits / MPW etc / MPW-GM / MPW / Examples / PPCExamples / CPlusExamples / CPlusTESample / TApplication.cp < prev    next >
Encoding:
Text File  |  1998-12-03  |  16.0 KB  |  543 lines  |  [TEXT/MPS ]
  1. /*------------------------------------------------------------------------------
  2. #
  3. #    Apple Macintosh Developer Technical Support
  4. #
  5. #    MultiFinder-Aware Simple Application Framework
  6. #
  7. #    TApplication
  8. #
  9. #    TApplication.cp        -    C++ source
  10. #
  11. #    Copyright © 1989 Apple Computer, Inc.
  12. #    All rights reserved.
  13. #
  14. #    Versions:    
  15. #            1.20                    10/91
  16. #            1.10                     07/89
  17. #            1.00                     04/89
  18. #
  19. #    Components:
  20. #            TApplicationCommon.h    July 9, 1989
  21. #            TApplication.h            July 9, 1989
  22. #            TApplication.cp            July 9, 1989
  23. #            TApplication.r            July 9, 1989
  24. #            TDocument.h                July 9, 1989
  25. #
  26. #    TApplication is a rudimentary application framework
  27. #    for C++.
  28. #
  29. ------------------------------------------------------------------------------*/
  30.  
  31.  
  32. /*
  33. Segmentation strategy:
  34.  
  35.     This program has only one segment, since the issues
  36.     surrounding segmentation within a class's methods have
  37.     not been investigated yet. We DO unload the data
  38.     initialization segment at startup time, which frees up
  39.     some memory 
  40.  
  41. SetPort strategy:
  42.  
  43.     Toolbox routines do not change the current port. In
  44.     spite of this, in this program we use a strategy of
  45.     calling SetPort whenever we want to draw or make calls
  46.     which depend on the current port. This makes us less
  47.     vulnerable to bugs in other software which might alter
  48.     the current port (such as the bug (feature?) in many
  49.     desk accessories which change the port on OpenDeskAcc).
  50.     Hopefully, this also makes the routines from this
  51.     program more self-contained, since they don't depend on
  52.     the current port setting. 
  53.  
  54. Clipboard strategy:
  55.  
  56.     This program does not maintain a private scrap.
  57.     Whenever a cut, copy, or paste occurs, we import/export
  58.     from the public scrap to TextEdit's scrap right away,
  59.     using the TEToScrap and TEFromScrap routines. If we did
  60.     use a private scrap, the import/export would be in the
  61.     activate/deactivate event and suspend/resume event
  62.     routines. 
  63. */
  64.  
  65. // Mac Includes
  66. #include <Types.h>
  67. #include <Quickdraw.h>
  68. #include <Fonts.h>
  69. #include <Controls.h>
  70. #include <Windows.h>
  71. #include <Menus.h>
  72. #include <TextEdit.h>
  73. #include <Dialogs.h>
  74. #include <Devices.h>
  75. #include <Events.h> 
  76. #include <Scrap.h>
  77. #include <TextUtils.h>
  78. #include <MacMemory.h>
  79. #include <SegLoad.h>
  80. #include <Files.h>
  81. #include <OSUtils.h>
  82. #include <Traps.h>
  83. #include <LowMem.h>
  84. #include <Processes.h>
  85.  
  86. #include "TApplication.h"                    // use the local version. If you make changes
  87.                                             // that you've debugged and want other files
  88.                                             // to use, simple copy this header file into
  89.                                             // the C++ Includes folder (don't forget to
  90.                                             // copy the TApplication object library to the C++
  91.                                             // Libraries folder)!
  92.  
  93. // OSEvent is the event number of the suspend/resume and mouse-moved events sent
  94. // by MultiFinder. Once we determine that an event is an osEvent, we look at the
  95. // high byte of the message sent to determine which kind it is. To differentiate
  96. // suspend and resume events we check the resumeMask bit.
  97. const short kOsEvent = app4Evt;                // event used by MultiFinder
  98. const short kSuspendResumeMessage = 0x01;    // high byte of suspend/resume event message
  99. const short kClipConvertMask = 0x02;        // bit of message field clip conversion
  100. const short kResumeMask = 0x01;                // bit of message field for resume vs. suspend
  101. const short kMouseMovedMessage = 0xFA;        // high byte of mouse-moved event message
  102.  
  103. #ifndef powerc
  104.  
  105. extern "C"
  106. { 
  107.     // from MPW standard library
  108.         void _DataInit(void);                // sets up A5 globals
  109. };
  110. #endif
  111.  
  112. QDGlobals    qd;
  113.  
  114. /***********************************************************************/
  115. //
  116. // TApplication class declarations
  117. //
  118. /***********************************************************************/
  119.  
  120. //-----------------------------------------------------------------------
  121. // TApplication::TApplication -     
  122. //
  123.     TApplication::TApplication( void )
  124.     {
  125.         SysEnvRec envRec;
  126.         long stkNeeded, heapSize;
  127.     
  128.         // initialize Mac Toolbox components
  129.             InitGraf (&qd.thePort);
  130.  
  131.             InitFonts();
  132.             InitWindows();
  133.             InitMenus();
  134.             TEInit();
  135.             InitDialogs(nil);
  136.             InitCursor();
  137.     
  138. #ifndef powerc
  139.         // Unload data segment: note that _DataInit must not be in Main!
  140.             UnloadSeg((ProcPtr) _DataInit);
  141. #endif
  142.  
  143.         // ignore the error returned from SysEnvirons; even if an error occurred,
  144.         // the SysEnvirons glue will fill in the SysEnvRec
  145.             ( void ) SysEnvirons( curSysEnvVers, &envRec );
  146.     
  147.         // Are we running on a 128K ROM machine or better???
  148.             if ( envRec.machineType < 0 )
  149.                 BigBadError( kErrStrings,eWrongMachine );        // if not, alert & quit
  150.     
  151.         // if we need more stack space, get it now
  152.             stkNeeded = StackNeeded();
  153.             if (stkNeeded > StackSpace())
  154.             {
  155.                 // new address is heap size + current stack - needed stack
  156.                     SetApplLimit((Ptr) ((long) GetApplLimit() - stkNeeded + StackSpace()));
  157.             }
  158.     
  159.         // Check for minimum heap size
  160.             heapSize = (long) GetApplLimit() - (long) ApplicationZone();
  161.             if ( heapSize < HeapNeeded())
  162.                 BigBadError( kErrStrings, eSmallSize );
  163.     
  164.         // expand the heap so new code segments load at the top
  165.             MaxApplZone();
  166.     
  167.         // allocate an empty document list
  168.             fDocList = new TDocumentList;
  169.     
  170.         // check to see if WaitNextEvent is implemented
  171.             fHaveWaitNextEvent = TrapAvailable( _WaitNextEvent, ToolTrap );
  172.     
  173.         // initialize our class variables
  174.             fCurDoc = nil;
  175.             fDone = false;
  176.             fInBackground = false;
  177.             fMouseRgn = nil;
  178.             fWhichWindow = nil;
  179.             
  180.     } /* TApplication (constructor) */
  181.  
  182.  
  183. //-----------------------------------------------------------------------
  184. // TApplication::ExitLoop -     we're quitting the application; let's
  185. //                                do whatever needs to be done to clean up.
  186. //                                In our case, there isn't much to be done.
  187. //
  188.     void TApplication::ExitLoop( void )
  189.     {
  190.         fDone = true;
  191.     }
  192.  
  193.  
  194. //-----------------------------------------------------------------------
  195. // TApplication::EventLoop -     keep track of events and handle them
  196. //                                appropriately.
  197. //
  198.     void TApplication::EventLoop( void )
  199.     {
  200.         int gotEvent;
  201.         EventRecord tEvt;
  202.     
  203.         SetUp();                    // call setup routine
  204.         DoIdle();                    // do idle once
  205.     
  206.         while (fDone == false)
  207.           {
  208.             // always set up fWhichWindow before doing anything
  209.                 fWhichWindow = FrontWindow();
  210.                 
  211.             // see if window belongs to a document
  212.                 fCurDoc = fDocList->FindDoc(fWhichWindow);
  213.                 
  214.             // make sure we always draw into correct window
  215.                 SetPort(fWhichWindow);
  216.     
  217.             // let's allow others to use the cpu if they need (Multifinder friendliness).
  218.                 DoIdle();            // call idle time handler. this lets apps blink the caret
  219.                                     // or whatever else they wish to do
  220.             
  221.             //     determine if an event has occurred and what to do about it
  222.                 if ( fHaveWaitNextEvent )
  223.                 {
  224.                     gotEvent = WaitNextEvent( everyEvent, &tEvt, SleepVal(), fMouseRgn );
  225.                 }
  226.                 else
  227.                 {
  228.                     SystemTask();
  229.                     gotEvent = GetNextEvent( everyEvent, &tEvt );
  230.                 }
  231.                 fTheEvent = tEvt;
  232.     
  233.             // make sure we got a real event
  234.                 if ( gotEvent )
  235.                 {
  236.                     AdjustCursor();
  237.                     switch (fTheEvent.what)
  238.                     {
  239.                         case mouseDown :    DoMouseDown();
  240.                                             break;
  241.                                             
  242.                         case mouseUp :        DoMouseUp();
  243.                                             break;
  244.                                             
  245.                         case keyDown :
  246.                         case autoKey :        DoKeyDown();
  247.                                             break;
  248.                                             
  249.                         case updateEvt :    DoUpdateEvt();                
  250.                                             break;
  251.                                             
  252.                         case diskEvt :        DoDiskEvt();
  253.                                             break;
  254.                                             
  255.                         case activateEvt :    DoActivateEvt();
  256.                                             break;
  257.                                             
  258.                         case kOsEvent :        DoOSEvent();
  259.                                             break;
  260.                                             
  261.                         default :            break;
  262.                         
  263.                     } // end switch (fTheEvent.what)
  264.                 }
  265.                 
  266.             // update the cursor shape as needed after the event
  267.                 AdjustCursor();
  268.         }
  269.         // call cleanup handler
  270.         CleanUp();
  271.         
  272.     }  /* TApplication::EventLoop */
  273.  
  274.  
  275. //-----------------------------------------------------------------------
  276. // TApplication::DoKeyDown -     simple routine to handle key presses.
  277. //
  278.     void TApplication::DoKeyDown( void )
  279.     {
  280.         char key;
  281.         long mResult;
  282.     
  283.         key = (char) ( fTheEvent.message & charCodeMask );
  284.         if (( fTheEvent.modifiers & cmdKey ) && ( fTheEvent.what == keyDown ))
  285.         {
  286.             // only do command keys if we are not autokeying
  287.                 AdjustMenus();                    // make sure menus are up to date
  288.                 mResult = MenuKey( key );
  289.                 if ( mResult != 0 )                // if it wasn't a menu key, pass it through
  290.                 {
  291.                     DoMenuCommand( HiWrd( mResult ), LoWrd( mResult ));
  292.                     return;
  293.                 }
  294.         }
  295.         
  296.         if ( fCurDoc != nil )
  297.         {
  298.             EventRecord tEvt;
  299.     
  300.             // we copy event record so that we don't pass reference to object field 
  301.             tEvt = fTheEvent;
  302.             fCurDoc->DoKeyDown( &tEvt );
  303.         }
  304.           
  305.     }  /* TApplication::DoKeyDown */
  306.  
  307.  
  308. //-----------------------------------------------------------------------
  309. // TApplication::DoActivateEvt -     a window is becoming active. if it is
  310. //                                    one of ours, call the document's activate
  311. //                                    routine.
  312. //
  313.     void TApplication::DoActivateEvt( void )
  314.     {
  315.         // event record contains window ptr
  316.             fWhichWindow = (WindowPtr) fTheEvent.message;
  317.  
  318.         // see if window belongs to a document
  319.             fCurDoc = fDocList->FindDoc( fWhichWindow );
  320.             SetPort( fWhichWindow );
  321.     
  322.         if ( fCurDoc != nil )
  323.           fCurDoc->DoActivate(( fTheEvent.modifiers & activeFlag ) != 0 );
  324.     
  325.     }  /* TApplication::DoActivateEvt */
  326.  
  327.  
  328. //-----------------------------------------------------------------------
  329. // TApplication::DoUpdateEvt -     a window needs to be updated. If it is one
  330. //                                of ours, call the document's update routine
  331. //                                to redraw it.
  332. //
  333.     void TApplication::DoUpdateEvt(void)
  334.     {
  335.         // event record contains window ptr
  336.             fWhichWindow = (WindowPtr) fTheEvent.message;
  337.  
  338.         // see if window belongs to a document
  339.             fCurDoc = fDocList->FindDoc( fWhichWindow );
  340.             SetPort( fWhichWindow );
  341.         
  342.             if ( fCurDoc != nil )
  343.                 fCurDoc->DoUpdate();
  344.           
  345.     }  /* TApplication::DoUpdateEvt */
  346.  
  347.  
  348. //-----------------------------------------------------------------------
  349. // TApplication::DoSuspend -     although our suspend and resume routine are
  350. //                                identical, let's use two distinct routines
  351. //                                so that a subclass can choose to override one
  352. //                                without having to rewrite the other.
  353. //
  354.     void TApplication::DoSuspend( Boolean doClipConvert )
  355.     {
  356.         doClipConvert = false;        // this is here because I HATE compiler warnings!!
  357.         if (fCurDoc != nil)
  358.           fCurDoc->DoActivate( !fInBackground );
  359.           
  360.     }  /* TApplication::DoSuspend */
  361.  
  362.  
  363. //-----------------------------------------------------------------------
  364. // TApplication::DoResume -     although our suspend and resume routine are
  365. //                                identical, let's use two distinct routines
  366. //                                so that a subclass can choose to override one
  367. //                                without having to rewrite the other.
  368. //
  369.     void TApplication::DoResume( Boolean doClipConvert )
  370.     {
  371.         doClipConvert = false;        // this is here because I HATE compiler warnings!!
  372.         if ( fCurDoc != nil )
  373.           fCurDoc->DoActivate( !fInBackground );
  374.           
  375.     }  /* TApplication::DoResume */
  376.  
  377.  
  378. //-----------------------------------------------------------------------
  379. // TApplication::DoOSEvent -     handle multifinder events accordingly.
  380. //
  381.     void TApplication::DoOSEvent(void)
  382.     {
  383.         Boolean doConvert;
  384.         unsigned char evType;
  385.     
  386.         // is it a multifinder event?
  387.             evType = (unsigned char) (fTheEvent.message >> 24) & 0x00ff;
  388.             switch ( evType )                    // high byte of message is type of event
  389.             {                                     
  390.                 case kMouseMovedMessage :        DoIdle();                    // mouse-moved is also an idle event
  391.                                                 break;
  392.                     
  393.                 case kSuspendResumeMessage :    doConvert = ( fTheEvent.message & kClipConvertMask ) != 0;
  394.                                                 fInBackground = ( fTheEvent.message & kResumeMask ) == 0;
  395.                                                 
  396.                                                 // depending on whether or not we're in the background call suspend or resume
  397.                                                     if ( fInBackground )
  398.                                                         DoSuspend( doConvert );
  399.                                                     else
  400.                                                         DoResume( doConvert );
  401.                                                 
  402.                                                 break;
  403.             }
  404.         
  405.     }  /* TApplication::DoOSEvent */
  406.  
  407.  
  408. //-----------------------------------------------------------------------
  409. // TApplication::DoMouseDown -     simple routine to handle a mouse click.
  410. //
  411.     void TApplication::DoMouseDown( void )
  412.     {
  413.         long        mResult;
  414.         short        partCode;
  415.         WindowPtr    tWind;
  416.         EventRecord    tEvt;
  417.     
  418.         // gotta watch those object field dereferences
  419.             partCode = FindWindow( fTheEvent.where, &tWind );
  420.             fWhichWindow = tWind;
  421.             tEvt = fTheEvent;
  422.             switch ( partCode )
  423.             {
  424.                 case inSysWindow :    DoMouseInSysWindow();
  425.                                     break;
  426.                                     
  427.                 case inMenuBar :    AdjustMenus();
  428.                                     mResult = MenuSelect( tEvt.where );
  429.                                     if ( mResult != 0 )
  430.                                       DoMenuCommand(HiWrd( mResult ), LoWrd( mResult ));
  431.                                     break;
  432.                                     
  433.                 case inGoAway :        DoGoAway();                    
  434.                                     break;
  435.                                     
  436.                 case inDrag :        DoDrag();
  437.                                     break;
  438.                                     
  439.                 case inGrow :        if ( fCurDoc != nil )
  440.                                           fCurDoc->DoGrow( &tEvt );                    
  441.                                     break;
  442.                 case inZoomIn :
  443.                 case inZoomOut :    if (( TrackBox(fWhichWindow, tEvt.where, partCode )) && ( fCurDoc != nil ))
  444.                                         fCurDoc->DoZoom(partCode);
  445.                                     break;
  446.                                     
  447.                 case inContent :    // If window is not in front, make it so
  448.                                         if ( fWhichWindow != FrontWindow() )
  449.                                             SelectWindow(fWhichWindow);
  450.                                         else
  451.                                             if (fCurDoc != nil)
  452.                                                  fCurDoc->DoContent(&tEvt);                    
  453.                                     break;
  454.             }
  455.           
  456.     }  /* TApplication::DoMouseDown */
  457.  
  458.  
  459. //-----------------------------------------------------------------------
  460. // TApplication::DoDrag -     have the system track the mouse movements and
  461. //                            drag the window accordingly.
  462. //
  463.     void TApplication::DoDrag( void )
  464.     {
  465.         DragWindow( fWhichWindow, fTheEvent.where, &qd.screenBits.bounds );
  466.         
  467.     }  /* TApplication::DoDrag */
  468.  
  469.  
  470. //-----------------------------------------------------------------------
  471. // TApplication::DoGoAway -     a mousedown event occurred in the go away region
  472. //                                of the active window; continue tracking it. If
  473. //                                the mouse is released in the region, then close
  474. //                                the window.
  475. //
  476.     void TApplication::DoGoAway( void )
  477.     {
  478.         if ( TrackGoAway( fWhichWindow, fTheEvent.where ))            // was the mouse released in the goAway region?
  479.         {                                                            // yes, but is the window ours?
  480.             if ( fCurDoc != nil )
  481.             {                                                        // it is our window, let's close it
  482.                 fDocList->RemoveDoc( fCurDoc );
  483.                 fCurDoc->DoClose();
  484.             }
  485.             else                                                    // no, the window must belong to the system, let them handle it
  486.                 CloseDeskAcc(((WindowPeek) fWhichWindow )->windowKind );
  487.                 
  488.             // make sure our current document/window references are valid
  489.                 if ( fWhichWindow != nil )                            // does an active window remain? 
  490.                 {
  491.                     fCurDoc = fDocList->FindDoc( fWhichWindow );    // yes, update the current document pointer
  492.                     SetPort( fWhichWindow );                        // be sure to make future drawings to the new window
  493.                 }
  494.                 else
  495.                     fCurDoc = nil;                                    // no active window remains
  496.         }
  497.     }  /* TApplication::DoGoAway */
  498.  
  499.  
  500. //-----------------------------------------------------------------------
  501. // TApplication::TrapAvailable -     Check and see if the trap exists. 
  502. //
  503.     Boolean TApplication::TrapAvailable(short tNumber,TrapType tType)
  504.     {
  505.         // On 64K ROM machines, tType will be ignored.
  506.             return NGetTrapAddress( tNumber, tType ) != NGetTrapAddress( _Unimplemented, ToolTrap);
  507.         
  508.     }  /* TApplication::TrapAvailable */
  509.  
  510.  
  511. //-----------------------------------------------------------------------
  512. // TApplication::AlertUser -     Simple routine to display an alert dialog
  513. //                                using str# resources. Although this routine
  514. //                                exists and is used in this sample, a more
  515. //                                streamlined approach would be to create a
  516. //                                dialog library (or even an object) which
  517. //                                could be linked in. Using such a method,only
  518. //                                one source copy would exist.
  519. //
  520.     void TApplication::AlertUser( short errResID, short errCode )
  521.     {
  522.         Str255 message;
  523.     
  524.         SetCursor( &qd.arrow );
  525.         GetIndString( message, errResID, errCode );
  526.         ParamText(message, (ConstStr255Param) "\p", (ConstStr255Param) "\p", (ConstStr255Param) "\p" );
  527.         (void) Alert( rUserAlert, nil);
  528.         
  529.     }  /* TApplication::AlertUser */
  530.  
  531. //-----------------------------------------------------------------------
  532. // TApplication::BigBadError -     A variation of AlertUser which aborts to
  533. //                                the finder. 
  534. //
  535.     void TApplication::BigBadError(short errResID, short errCode)
  536.     {
  537.         AlertUser( errResID,errCode );
  538.         ExitToShell();
  539.         
  540.     }  /* TApplication::BigBadError */
  541.     
  542. // That's all, folks...
  543.